/*
 * Copyright (c) 2025 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

export interface ITaskContext {
  /**
   * 将源文件路径映射为输出文件路径
   * @param absSourceFile 源文件的绝对路径
   * @returns 输出文件的绝对路径
   * @example
   * 'module/src/main/ets/User.ets' -> '/module/src/generated/ets/User.ets'
   */
  mapToOutputPath(absSourceFile: string): string

  /**
   * 获取输出根目录
   * 返回所有生成文件的根目录路径
   * @returns 输出根目录的绝对路径
   * @example
   * 'module/src/generated'
   */
  getOutputRoot(): string

  /**
   * 获取模块名称
   * 返回当前模块module.json5中配置的name字段
   * @returns 输出当前模块module.json5中配置的name字段
   */
  getModuleName(): string

  /**
   * 获取模块根路径
   * @returns 输出当前模块根路径
   */
  getModulePath(): string

  /**
   * 获取package名称
   * 返回当前模块oh-package.json5中配置的name字段
   * @returns 输出当前模块oh-package.json5中配置的name字段
   */
  getPackageName(): string

  /**
   * 获取文件的相对路径
   * 将绝对路径转换为相对于项目根目录的路径
   * 主要用于日志显示和错误报告
   * @param absolutePath 绝对文件路径
   * @returns 相对于项目根目录的路径
   * @example
   * 'module/src/main/ets/User.ets' -> 'src/main/ets/User.ets'
   */
  getRelativePath(absolutePath: string): string

  /**
   * 检查输出路径是否有效
   * 验证输出路径是否满足当前环境的要求
   * 用于路径映射的安全性检查
   * @param outputPath 输出文件路径
   * @returns 路径是否有效
   */
  isValidOutputPath(outputPath: string): boolean

  /**
   * 确保输出目录存在
   * 创建输出文件所需的目录结构
   * @param outputPath 输出文件路径
   * @returns Promise<void>
   */
  ensureOutputDirectory(outputPath: string): void


  /**
   * 计算相对于模块根目录的路径
   * 剔除sourceRoots路径前缀，默认包含 './src/main'
   *
   * @param absolutePath 文件的绝对路径
   * @returns 相对于模块根的路径（剔除src/main或src/generated前缀）
   * @example
   * 'module/src/main/ets/User.ets' -> '/ets/User.ets'
   */
  calculateSourceRootToModuleRoot(absolutePath: string): string
}
